/*
 * Licensed to The Apereo Foundation under one or more contributor license
 * agreements. See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 *
 * The Apereo Foundation licenses this file to you under the Educational
 * Community License, Version 2.0 (the "License"); you may not use this file
 * except in compliance with the License. You may obtain a copy of the License
 * at:
 *
 *   http://opensource.org/licenses/ecl2.txt
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
 * License for the specific language governing permissions and limitations under
 * the License.
 *
 */
package org.opencastproject.transcription.api;

import org.opencastproject.job.api.Job;
import org.opencastproject.mediapackage.MediaPackageElement;
import org.opencastproject.mediapackage.Track;

import java.util.Map;

/*
 * API for asynchronous external automated transcription service.
 * Supports starting a transcription job and getting a callback when transcription is done.
 */
public interface TranscriptionService {
  /*
   * Start transcription job on external service
   */
  Job startTranscription(String mpId, Track track) throws TranscriptionServiceException;

  /*
   * Start transcription job on external service
   */
  Job startTranscription(String mpId, Track track, String... args) throws TranscriptionServiceException;

  /*
   * Get element containing transcription generated by external service
   */
  MediaPackageElement getGeneratedTranscription(String mpId, String jobId, MediaPackageElement.Type type)
          throws TranscriptionServiceException;

  /*
   * Called when external service finished transcription.
   */
  void transcriptionDone(String mpId, Object results) throws TranscriptionServiceException;

  /*
   * Called when external service reported an error in transcription.
   */
  void transcriptionError(String mpId, Object results) throws TranscriptionServiceException;

  /*
   * Returns a string representing the language supported.
   */
  String getLanguage();

  /*
   * Get key-value pairs generated by the start handler that the attach handler needs to know about (if you need to
   * pass more information than the transcription element itself)
   */
  Map<String, Object> getReturnValues(String mpId, String jobId) throws TranscriptionServiceException;
}
